home *** CD-ROM | disk | FTP | other *** search
/ PC World Komputer 2010 April / PCWorld0410.iso / hity wydania / Ubuntu 9.10 PL / karmelkowy-koliberek-desktop-9.10-i386-PL.iso / casper / filesystem.squashfs / usr / share / pyshared / jockey / detection.py < prev    next >
Encoding:
Python Source  |  2009-07-20  |  37.5 KB  |  996 lines
  1. # -*- coding: UTF-8 -*-
  2.  
  3. '''Check the hardware and software environment on the computer for available
  4. devices, query the driver database, and generate a set of handlers.
  5.  
  6. The central function is get_handlers() which checks the system for available
  7. hardware and, if given a driver database, queries that about updates and
  8. unknown hardware.
  9. '''
  10.  
  11. # (c) 2007 Canonical Ltd.
  12. #
  13. # This program is free software; you can redistribute it and/or modify
  14. # it under the terms of the GNU General Public License as published by
  15. # the Free Software Foundation; either version 2 of the License, or
  16. # (at your option) any later version.
  17. #
  18. # This program is distributed in the hope that it will be useful,
  19. # but WITHOUT ANY WARRANTY; without even the implied warranty of
  20. # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21. # GNU General Public License for more details.
  22. #
  23. # You should have received a copy of the GNU General Public License along
  24. # with this program; if not, write to the Free Software Foundation, Inc.,
  25. # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  26.  
  27. import os, os.path, subprocess, sys, logging, re
  28. import cPickle, xmlrpclib, locale
  29. from glob import glob
  30.  
  31. from oslib import OSLib
  32. import handlers, xorg_driver
  33.  
  34. #--------------------------------------------------------------------#
  35.  
  36. class HardwareID:
  37.     '''A piece of hardware is denoted by an identification type and value.
  38.  
  39.     The most common identification type is a 'modalias', but in the future we
  40.     might support other types (such as bus/vendorid/productid, printer
  41.     device ID, etc.).
  42.     '''
  43.     _recache = {}
  44.  
  45.     def __init__(self, type, id):
  46.         self.type = type
  47.         self.id = id
  48.  
  49.     def __repr__(self):
  50.         return "HardwareID('%s', '%s')" % (self.type, self.id)
  51.  
  52.     def __eq__(self, other):
  53.         if type(self) != type(other) or self.type != other.type:
  54.             return False
  55.  
  56.         if self.type != 'modalias':
  57.             return self.id == other.id
  58.  
  59.         # modalias pattern matching
  60.         if '*' in self.id:
  61.             # if used as dictionary keys we do need to compare two patterns; in
  62.             # that case they should just be tested for string equality
  63.             if '*' in other.id:
  64.                 return self.id == other.id
  65.             else:
  66.                 return self.regex(self.id).match(other.id)
  67.         else:
  68.             if '*' in other.id:
  69.                 return self.regex(other.id).match(self.id)
  70.             else:
  71.                 return self.id == other.id
  72.  
  73.     def __ne__(self, other):
  74.         return not self.__eq__(other)
  75.  
  76.     def __hash__(self):
  77.         # This is far from efficient, but we usually have a very small number
  78.         # of handlers, so it doesn't matter.
  79.  
  80.         if self.type == 'modalias':
  81.             # since we might have patterns, we cannot rely on hash identidy of
  82.             # id
  83.             return hash(self.type) ^ hash(self.id[:self.id.find(':')])
  84.         else:
  85.             return hash(self.type) ^ hash(self.id)
  86.  
  87.     @classmethod
  88.     def regex(klass, pattern):
  89.         '''Convert modalias pattern to a regular expression.'''
  90.  
  91.         r = klass._recache.get(pattern)
  92.         if not r:
  93.             r = re.compile(re.escape(pattern).replace('\\*', '.*') + '$')
  94.             klass._recache[pattern] = r
  95.         return r
  96.  
  97. #--------------------------------------------------------------------#
  98.  
  99. class DriverID:
  100.     '''Driver database entry describing a driver.
  101.     
  102.     This consists of a set of (type, value) pairs, the semantics of which can
  103.     be defined and used freely for every distribution. A few conventional
  104.     standard types exist:
  105.     
  106.     - driver_type: 'kernel_module' | 'printer_driver' | ... [required]
  107.     - description: locale ΓåÆ string (human-readable single-line) [required]
  108.     - long_description: locale ΓåÆ string (human-readable paragraph) [optional]
  109.     - driver_vendor: very short string, requirements as in pci.ids [required]
  110.     - version: string, arbitrary differentiation [optional]
  111.     - jockey_handler: class name (inferred from driver_type for standard handlers) [optional]
  112.     - repository: URL [optional]
  113.     - package: string [optional]
  114.     - free: boolean (licensed as free software) [required]
  115.     - license: string (license text) [required if free is False]
  116.     '''
  117.     def __init__(self, **properties):
  118.         self.properties = properties
  119.  
  120.     def __getitem__(self, key):
  121.         return self.properties.__getitem__(key)
  122.  
  123.     def __contains__(self, key):
  124.         return self.properties.__contains__(key)
  125.  
  126.     def __setitem__(self, key, value):
  127.         self.properties.__setitem__(key, value)
  128.  
  129. #--------------------------------------------------------------------#
  130.  
  131. class DriverDB:
  132.     '''Interface definition for a driver database.
  133.     
  134.        This maps a HWIdentifier to a list of DriverID instances (sorted by
  135.        preference) which match the OS version.
  136.  
  137.        Initialization of a DriverDB should be relatively cheap. For DBs
  138.        querying remote services this means that they should not do remote
  139.        operations in __init__() and query(), only in update().
  140.  
  141.        This base class also provides caching infrastructure.
  142.        '''
  143.  
  144.     def __init__(self, use_cache=False):
  145.         '''Initialize the DriverDB.
  146.         
  147.         This also initializes the cache if caching is used.
  148.         '''
  149.         self.use_cache = use_cache
  150.         self.cache = None
  151.         if self.use_cache:
  152.             assert self._cache_id()
  153.             self.cache_path = os.path.join(OSLib.inst.backup_dir,
  154.                 'driverdb-%s.cache' % self._cache_id())
  155.             try:
  156.                 self.cache = cPickle.load(open(self.cache_path, 'rb'))
  157.             except (cPickle.PickleError, IOError), e:
  158.                 logging.warning('Could not open DriverDB cache %s: %s',
  159.                     self.cache_path, str(e))
  160.                 self.cache = None
  161.  
  162.     def query(self, hwid):
  163.         '''Return a set or list of applicable DriverIDs for a HardwareID.
  164.         
  165.         This uses the cache, if available, and otherwise calls _do_query().
  166.         '''
  167.         if self.use_cache and self.cache is not None:
  168.             return self.cache.get(hwid, [])
  169.  
  170.         return self._do_query(hwid)
  171.  
  172.     def update(self, hwids):
  173.         '''Query remote server for driver updates for a set of HardwareIDs.
  174.  
  175.         This is a no-op for local-only driver databases. For remote ones, this
  176.         is the only method which should actually do network operations.
  177.         When enabling caching in __init__, this takes care of writing the
  178.         cache.
  179.         '''
  180.         logging.debug('updating %s', self)
  181.         self._do_update(hwids)
  182.  
  183.         # write cache
  184.         if self.use_cache:
  185.             try:
  186.                 f = open(self.cache_path, 'wb')
  187.                 cPickle.dump(self.cache, f)
  188.                 f.close()
  189.             except (cPickle.PickleError, IOError), e:
  190.                 logging.warning('Could not create DriverDB cache %s: %s',
  191.                     self.cache_path, str(e))
  192.  
  193.     #
  194.     # The following methods must be implemented in subclasses
  195.     # 
  196.  
  197.     def _cache_id(self):
  198.         '''Get the cache ID for this DriverDB.
  199.  
  200.         If the driver DB implementation uses disk caching, it needs to define
  201.         an unique ID for the cache file name. For parameterized DBs (such as a
  202.         remote DB with a particular URL), those parameters must be included
  203.         into the cache ID.
  204.         
  205.         By default this returns the classname, which is appropriate for
  206.         singleton DriverDBs.
  207.         '''
  208.         return str(self.__class__).split('.')[-1]
  209.  
  210.     def _do_query(self, hwid):
  211.         '''Return a set or list of applicable DriverIDs for a HardwareID.
  212.  
  213.         This should not be called directly. Users call query() which wraps this
  214.         function into caching.
  215.         '''
  216.         raise NotImplementedError, 'subclasses need to implement this'
  217.  
  218.     def _do_update(self, hwids):
  219.         '''Query remote server for driver updates for a set of HardwareIDs.
  220.  
  221.         This should not be called directly. Users call update() which wraps this
  222.         function into caching.
  223.  
  224.         This is a no-op for local-only driver databases. For remote ones, this
  225.         is the only method which should actually do network operations.
  226.         When enabling caching in __init__, implementations need to write the
  227.         detected hardware->driver mapping into self.cache (mapping HardwareID
  228.         to a set/list of DriverIDs).
  229.         '''
  230.         pass
  231.  
  232. #--------------------------------------------------------------------#
  233.  
  234. class LocalKernelModulesDriverDB(DriverDB):
  235.     '''DriverDB implementation for kernel modules which are already available
  236.     in the system.
  237.     
  238.     This evaluates modalias lists and overrides (such as /lib/modules/<kernel
  239.     version>/modules.alias and other alias files/directories specified in
  240.     OSLib.modaliases) to map modaliases in /sys to kernel modules and wrapping
  241.     them into a KernelModuleHandler.
  242.     
  243.     As an addition to the 'alias' lines in modalias files, you can also specify
  244.     lines "reset <module>" which will cause the current modalias mapping that
  245.     was built up to that point to be discarded. Since modaliases are evaluated
  246.     in the order they appear in OSLib.modaliases, this can be used to disable
  247.     wrong upstream modaliases (like the ones from the proprietary NVIDIA
  248.     graphics driver).
  249.     '''
  250.     def __init__(self):
  251.         '''Initialize self.alias_cache.
  252.         
  253.         This maps bus ΓåÆ vendor ΓåÆ modalias ΓåÆ [module].
  254.         '''
  255.         # TODO: check if caching is beneficial
  256.         DriverDB.__init__(self, use_cache=False)
  257.         self.update({})
  258.  
  259.     def _do_update(self, hwids):
  260.         # bus -> vendor -> alias -> [(module, package)]; vendor == None -> no vendor,
  261.         # or vendor patterns, needs fnmatching
  262.         self.alias_cache = {} 
  263.         # patterns for which we can optimize lookup
  264.         self.vendor_pattern_re = re.compile('(pci|usb):v([0-9A-F]{4,8})(?:d|p)')
  265.  
  266.         for alias_location in OSLib.inst.modaliases:
  267.             if not os.path.exists(alias_location):
  268.                 continue
  269.             if os.path.isdir(alias_location):
  270.                 alias_files = [os.path.join(alias_location, f) 
  271.                     for f in sorted(os.listdir(alias_location))]
  272.             else:
  273.                 alias_files = [alias_location]
  274.  
  275.             for alias_file in alias_files:
  276.                 logging.debug('reading modalias file ' + alias_file)
  277.                 for line in open(alias_file):
  278.                     fields = line.split()
  279.                     try:
  280.                         (c, a, m, p) = fields
  281.                     except ValueError:
  282.                         p = None
  283.                         try:
  284.                             (c, a, m) = fields
  285.                         except ValueError:
  286.                             try:
  287.                                 (c, m) = line.split()
  288.                                 a = None
  289.                             except ValueError:
  290.                                 continue
  291.  
  292.                     if c == 'alias' and a:
  293.                         vp = self.vendor_pattern_re.match(a)
  294.                         if vp:
  295.                             self.alias_cache.setdefault(vp.group(1), {}).setdefault(
  296.                                 vp.group(2), {}).setdefault(a, []).append((m, p))
  297.                         else:
  298.                             colon = a.find(':')
  299.                             if colon > 0:
  300.                                 bus = a[:colon]
  301.                             else:
  302.                                 bus = None
  303.                             self.alias_cache.setdefault(bus, {}).setdefault(
  304.                                 None, {}).setdefault(a, []).append((m, p))
  305.                     elif c == 'reset':
  306.                         for map in self.alias_cache.itervalues():
  307.                             for vmap in map.itervalues():
  308.                                 for k, mods in vmap.iteritems():
  309.                                     for i in range(len(mods)):
  310.                                         if mods[i][0] == m:
  311.                                             mods.pop(i)
  312.                                             break
  313.  
  314.             #for bus, inf in self.alias_cache.iteritems():
  315.             #    print '*********', bus, '*************'
  316.             #    for vendor, alias in inf.iteritems():
  317.             #        print '#', vendor, ':', alias
  318.  
  319.     def _do_query(self, hwid):
  320.         '''Return a list of applicable DriverIDs for a HardwareID.'''
  321.  
  322.         if hwid.type != 'modalias' or ':' not in hwid.id:
  323.             return []
  324.  
  325.         # we can't build large dictionaries with HardwareID as keys, that's too
  326.         # inefficient; thus we have to do some more clever matching and data
  327.         # structure
  328.  
  329.         # TODO: we return all matching handlers here, which is
  330.         # confusing; picking the first one is too arbitrary, though;
  331.         # find a good heuristics for returning the best one
  332.  
  333.         result = []
  334.  
  335.         # look up vendor patterns
  336.         m = self.vendor_pattern_re.match(hwid.id)
  337.         if m:
  338.             bus = m.group(1)
  339.             for a, mods in self.alias_cache.get(bus, {}).get(m.group(2), {}).iteritems():
  340.                 if mods and HardwareID('modalias', a) == hwid:
  341.                     for (m, p) in mods:
  342.                         did = DriverID(driver_type='kernel_module', kernel_module=m)
  343.                         if p:
  344.                             did.properties['package'] = p
  345.                         result.append(did)
  346.         else:
  347.             bus = hwid.id[:hwid.id.index(':')]
  348.  
  349.         # look up the remaining ones
  350.         for a, mods in self.alias_cache.get(bus, {}).get(None, {}).iteritems():
  351.             if mods and HardwareID('modalias', a) == hwid:
  352.                 for (m, p) in mods:
  353.                     did = DriverID(driver_type='kernel_module', kernel_module=m)
  354.                     if p:
  355.                         did.properties['package'] = p
  356.                     result.append(did)
  357.  
  358.         return result
  359.  
  360. #--------------------------------------------------------------------#
  361.  
  362. class XMLRPCDriverDB(DriverDB):
  363.     '''DriverDB implementation for a remote XML-RPC server.
  364.  
  365.     This implements XML-RPC DriverDB protocol version 20080407:
  366.  
  367.     query: (protocol_version, protocol_subversion, query_data) ΓåÆ
  368.       (protocol_version, protocol_subversion, HardwareID ΓåÆ DriverID*])
  369.     
  370.     HardwareID: hwid_type ':' hwid_value
  371.     hwid_type: 'modalias' | 'printer_deviceid'
  372.     hwid_value: string (modalias value, printer device ID, etc.)
  373.     DriverID: property ΓåÆ value
  374.     
  375.     Example:
  376.     query('20080407', '0', {
  377.             'components': ['modalias:pci:crap', 'printer:Canon_BJ2'],
  378.             'system_vendor': 'Dell',
  379.             'system_product': 'Latitude D430',
  380.             'os_name': 'RedSock',
  381.             'os_version': '2.0',
  382.             'kernel_ver': '2.6.24-15-generic',
  383.             'architecture': 'i686'}) =
  384.       ('20080407', '0', {'modalias:pci:crap': [dr_crap1, dr_crap2], 'printer:Canon_BJ2': [dr_pr1]})
  385.  
  386.     where dr_* are DriverID property dictionaries.
  387.     '''
  388.     def __init__(self, url):
  389.         '''Create XML-RPC Driver DB instance for a given server URL.'''
  390.  
  391.         self.url = url
  392.         DriverDB.__init__(self, use_cache=True)
  393.         (self.sys_vendor, self.sys_product) = OSLib.inst.get_system_vendor_product()
  394.  
  395.     def _cache_id(self):
  396.         # chop off protocol from URL, and remove slashes
  397.         u = self.url
  398.         pos = u.find('://')
  399.         if pos >= 0:
  400.             u = u[(pos+3):]
  401.         u = u.replace('/', '_')
  402.  
  403.         return DriverDB._cache_id(self) + '@' + u
  404.  
  405.     def _do_query(self, hwid):
  406.         '''Return a set or list of applicable DriverIDs for a HardwareID.'''
  407.  
  408.         # we only get here if we haven't update()d, since after that the cache
  409.         # does its magic
  410.         return []
  411.  
  412.     def _do_update(self, hwids):
  413.         '''Query remote server for driver updates for a set of HardwareIDs.'''
  414.  
  415.         logging.debug('Querying XML-RPC driver database %s...', self.url)
  416.         client = xmlrpclib.ServerProxy(self.url)
  417.         # TODO: error handling; pass kernel_version, architecture
  418.         (res_proto_ver, res_proto_subver, drivers) = client.query(
  419.             '20080407', '0', { 
  420.             'os_name': OSLib.inst.os_vendor,
  421.             'os_version': OSLib.inst.os_version, 
  422.             'system_vendor': self.sys_vendor,
  423.             'system_product': self.sys_product,
  424.             'components': ['%s:%s' % (h.type, h.id) for h in hwids]
  425.             })
  426.         logging.debug('  -> protocol: %s/%s, drivers: %s', res_proto_ver,
  427.             res_proto_subver, str(drivers))
  428.  
  429.         self.cache = {}
  430.         if res_proto_ver != '20080407':
  431.             logging.warning('   unknown protocol version, not updating')
  432.             return
  433.  
  434.         for hwid in hwids:
  435.             for drv in drivers.get('%s:%s' % (hwid.type, hwid.id), []):
  436.                 if 'driver_type' not in drv:
  437.                     continue
  438.                 self.cache.setdefault(hwid, []).append(DriverID(**drv))
  439.  
  440. #--------------------------------------------------------------------#
  441.  
  442. class OpenPrintingDriverDB(DriverDB):
  443.     '''DriverDB for openprinting.org printer drivers.'''
  444.  
  445.     def __init__(self):
  446.             DriverDB.__init__(self, use_cache=True)
  447.  
  448.     def _do_query(self, hwid):
  449.         '''Return a set or list of applicable DriverIDs for a HardwareID.'''
  450.  
  451.         # we only get here if we haven't update()d, since after that the cache
  452.         # does its magic
  453.         return []
  454.  
  455.     def _do_update(self, hwids):
  456.         '''Query remote server for driver updates for a set of HardwareIDs.'''
  457.  
  458.         # map OSLib.packaging_system() strings to OpenPrinting.org
  459.         # "packagesystem" arguments
  460.         pkg_system_map = {
  461.             'apt': 'deb',
  462.             'yum': 'rpm',
  463.             'urpmi': 'rpm',
  464.         }
  465.  
  466.         pkgsystem = OSLib.inst.packaging_system()
  467.         try:
  468.             opo_pkgsystem = pkg_system_map[pkgsystem]
  469.         except KeyError:
  470.             logging.warning('cannot map local packaging system to an OpenPrinting.org supported one')
  471.             return
  472.  
  473.         try:
  474.             import cupshelpers
  475.         except ImportError:
  476.             logging.warning('cupshelpers Python module is not present; openprinting.org query is not available')
  477.             return
  478.  
  479.         def _pkgname_from_fname(pkgname):
  480.             '''Extract package name from a package file name.'''
  481.  
  482.             if pkgname.endswith('.deb'):
  483.                 return pkgname.split('_')[0]
  484.             elif pkgname.endswith('.rpm'):
  485.                 return '-'.join(pkgname.split('-')[0:-2])
  486.             else:
  487.                 raise ValueError, 'Unknown package type: ' + pkgname
  488.  
  489.         def _ld_callback(status, drv_list, data):
  490.             if status != 0:
  491.                 logging.error('  openprinting.org query failed: %s', str(data))
  492.                 return
  493.  
  494.             for driver, info in data.iteritems():
  495.                 logging.debug('OpenPrintingDriverDB: driver %s info: %s',
  496.                     driver, str(info))
  497.                 pkgs = info.get('packages', {})
  498.                 arches = pkgs.keys()
  499.                 if len(arches) == 0:
  500.                     logging.debug('No packages for ' + info['name'])
  501.                     continue
  502.                 if len(arches) > 1:
  503.                     logging.error('Returned more than one matching architecture, please report this as a bug: %s', str(arches))
  504.                     continue
  505.                 pkgs = pkgs[arches[0]]
  506.  
  507.                 if len(pkgs) != 1:
  508.                     logging.error('Returned more than one package, this is currently not handled')
  509.                     return
  510.                 pkg = pkgs.keys()[0]
  511.  
  512.                 repo = pkgs[pkg].get('repositories', {}).get(pkgsystem)
  513.                 if not repo:
  514.                     logging.error('Local package system %s not found in %s',
  515.                         pkgsystem, pkgs[pkg].get('repositories', {}))
  516.                     return
  517.  
  518.                 desc = info.get('shortdescription',
  519.                     info['name']).replace('<b>', '').replace('</b>',
  520.                     '').replace('<br>', ' ')
  521.  
  522.                 did = DriverID(driver_type='printer_driver',
  523.                     description={'C': desc},
  524.                     driver_vendor=info.get('supplier', 'openprinting.org').replace(' ', '_'),
  525.                     free=info.get('freesoftware', False),
  526.                     package=_pkgname_from_fname(pkg),
  527.                     repository=repo,
  528.                     recommended=info.get('recommended', False),
  529.                 )
  530.                 desc = ''
  531.                 if 'functionality' in info:
  532.                     desc = 'Functionality:'
  533.                     for f, percent in info['functionality'].iteritems():
  534.                         desc += '\n  %s: %s%%' % (f, percent)
  535.                     desc += '\n'
  536.                 if 'supplier' in info:
  537.                     desc += 'Supplied by: ' + info['supplier']
  538.                     if info.get('manufacturersupplied'):
  539.                         desc += ' (printer manufacturer)'
  540.                     desc += '\n'
  541.                 if 'supportcontacts' in info:
  542.                     desc += 'Support contacts:\n'
  543.                     for s in info['supportcontacts']:
  544.                         desc += ' - %s (%s): %s' % (s['name'],
  545.                             s.get('level', 'voluntary'), s['url'])
  546.                 did.properties['long_description'] = {'C': desc}
  547.  
  548.                 # needed to disambiguate e. g. splix and splix2
  549.                 if driver != did.properties['package']:
  550.                     did.properties['version'] = driver.replace('driver/', '')
  551.  
  552.                 if 'licensetext' in info:
  553.                     did.properties['license'] = info['licensetext']
  554.  
  555.                 drv_list.append(did)
  556.  
  557.         logging.debug('Querying openprinting.org database...')
  558.         self.cache = {}
  559.         op = cupshelpers.openprinting.OpenPrinting()
  560.         op.onlyfree = 0
  561.  
  562.         # fire searches for all detected printers
  563.         threads = []
  564.         for hwid in hwids:
  565.             if hwid.type != 'printer_deviceid':
  566.                 continue
  567.             logging.debug('   ... querying for %s', hwid.id)
  568.             t = op.listDrivers(hwid.id, _ld_callback,
  569.                 self.cache.setdefault(hwid, []), 
  570.                 extra_options={'packagesystem': opo_pkgsystem, 'architectures': 'noarch'})
  571.             threads.append(t)
  572.  
  573.         # wait until all threads have finished
  574.         for t in threads:
  575.             t.join()
  576.  
  577. #--------------------------------------------------------------------#
  578. # internal helper functions
  579.  
  580. def _get_modaliases():
  581.     '''Return a set of modalias HardwareIDs for available hardware.'''
  582.  
  583.     if _get_modaliases.cache:
  584.         return _get_modaliases.cache
  585.  
  586.     hw = set()
  587.     for path, dirs, files in os.walk(os.path.join(OSLib.inst.sys_dir, 'devices')):
  588.         modalias = None
  589.  
  590.         # most devices have modalias files
  591.         if 'modalias' in files:
  592.             modalias = open(os.path.join(path, 'modalias')).read().strip()
  593.         # devices on SSB bus only mention the modalias in the uevent file (as
  594.         # of 2.6.24)
  595.         elif 'ssb' in path and 'uevent' in files:
  596.             info = {}
  597.             for l in open(os.path.join(path, 'uevent')):
  598.                 if l.startswith('MODALIAS='):
  599.                     modalias = l.split('=', 1)[1].strip()
  600.                     break
  601.  
  602.         if not modalias:
  603.             continue
  604.  
  605.         # ignore drivers which are statically built into the kernel
  606.         driverlink =  os.path.join(path, 'driver')
  607.         modlink = os.path.join(driverlink, 'module')
  608.         if os.path.islink(driverlink) and not os.path.islink(modlink):
  609.             continue
  610.  
  611.         hw.add(HardwareID('modalias', modalias))
  612.  
  613.     _get_modaliases.cache = hw
  614.     return hw
  615.  
  616. _get_modaliases.cache = None
  617.  
  618. def _get_printers():
  619.     '''Return a set of HardwareIDs for connected printers.'''
  620.  
  621.     if _get_printers.cache is not None:
  622.         return _get_printers.cache
  623.  
  624.     _get_printers.cache = set()
  625.  
  626.     try:
  627.         import cups
  628.         import cupshelpers
  629.     except ImportError:
  630.         logging.warning('cups and/or cupshelpers Python modules are not present; printer detection is not available')
  631.         return _get_printers.cache
  632.  
  633.     try:
  634.         for dev in cupshelpers.getDevices(cups.Connection()).itervalues():
  635.             # openprinting.org database only uses MFG, MDL, DES, and CMD, so don't
  636.             # send the rest (it might contain personal data such as serial numbers)
  637.             if dev.id_dict.get('MFG') and dev.id_dict.get('MDL'):
  638.                 id = 'MFG:%s;MDL:%s;' % (dev.id_dict['MFG'], dev.id_dict['MDL'])
  639.                 if dev.id_dict.get('DES'):
  640.                     id += 'DES:' + dev.id_dict['DES'] + ';'
  641.                 if dev.id_dict.get('CMD'):
  642.                     id += 'CMD:' + ','.join(dev.id_dict['CMD']) + ';'
  643.                 _get_printers.cache.add(HardwareID('printer_deviceid', id))
  644.     except (RuntimeError, cups.IPPError):
  645.         logging.warning('cannot connect to cups; printer detection is not available')
  646.         return set()
  647.            
  648.     return _get_printers.cache
  649.  
  650. _get_printers.cache = None
  651.  
  652. def _handler_license_filter(handler, mode):
  653.     '''Filter handlers by license.
  654.     
  655.     Return handler if the handler is compatible with mode (MODE_FREE,
  656.     MODE_NONFREE, or MODE_ANY), else return None.
  657.     '''
  658.     if mode == MODE_FREE and handler and not handler.free():
  659.         return None
  660.     elif mode == MODE_NONFREE and handler and handler.free():
  661.         return None
  662.     return handler
  663.  
  664. def _driverid_to_handler(did, backend, mode):
  665.     '''Create handler for a DriverID from a handler pool.
  666.  
  667.     mode is MODE_FREE, MODE_NONFREE, or MODE_ANY; see get_handlers() for
  668.     details.
  669.     '''
  670.     explicit_handler = 'jockey_handler' in did
  671.     if not explicit_handler:
  672.         if 'driver_type' not in did:
  673.             return None
  674.  
  675.         if did['driver_type'] == 'kernel_module':
  676.             did['jockey_handler'] = 'KernelModuleHandler'
  677.         elif did['driver_type'] == 'printer_driver':
  678.             did['jockey_handler'] = 'PrinterDriverHandler'
  679.         else:
  680.             logging.warning('Cannot map driver type %s to a default handler' %
  681.                 did['driver_type'])
  682.             return None
  683.  
  684.     kwargs = did.properties.copy()
  685.     args = []
  686.  
  687.     # special treatment of some standard attributes: those must be applied
  688.     # to the particular handler instance
  689.     for a in ('driver_type', 'jockey_handler', 'version', 'description',
  690.         'long_description', 'repository', 'package', 'driver_vendor', 'free',
  691.         'license', 'recommended'):
  692.         try:
  693.             del kwargs[a]
  694.         except KeyError:
  695.             pass
  696.  
  697.     hclass = None
  698.  
  699.     # instantiation of kernel module handlers; first try to find a custom
  700.     # handler for this module
  701.     if did['jockey_handler'] in ('KernelModuleHandler', 'FirmwareHandler') and \
  702.             'kernel_module' in did:
  703.         if not explicit_handler:
  704.             # if the DriverDB did not set a handler explicitly, custom handlers
  705.             # win over autogenerated standard ones
  706.             for h in backend.handler_pool.itervalues():
  707.                 if isinstance(h, handlers.KernelModuleHandler) and \
  708.                     h.module == did['kernel_module']:
  709.                     del kwargs['kernel_module']
  710.                     hclass = h.__class__
  711.                     break
  712.  
  713.         if not hclass:
  714.             # no custom handler ΓåÆ fall back to creating a standard one
  715.  
  716.             # lazily initialize and check ignored modules
  717.             if _driverid_to_handler.ignored is None:
  718.                 _driverid_to_handler.ignored = OSLib.inst.ignored_modules()
  719.             if did['kernel_module'] not in _driverid_to_handler.ignored:
  720.                 # only create default handlers for modules which actually
  721.                 # exist or which we can install
  722.                 if not get_modinfo(did['kernel_module']):
  723.                     if 'free' not in did.properties or \
  724.                        'description' not in did.properties or \
  725.                        'package' not in did.properties:
  726.                        logging.warning('DriverID for module %s does not refer '
  727.                            'to a locally available module and does not specify '
  728.                            'free/description/package; ignoring', did['kernel_module'])
  729.                        return None
  730.  
  731.                 hclass = getattr(handlers, did['jockey_handler'])
  732.  
  733.                 # kernel_module is a positional parameter
  734.                 args.append(did['kernel_module'])
  735.                 del kwargs['kernel_module']
  736.  
  737.                 # KernelModuleHandler needs the name passed for non-local
  738.                 # kmods; we override it later anyway, so just pass a dummy
  739.                 if 'description' in did.properties and 'name' not in kwargs:
  740.                     kwargs['name'] = 'dummy'
  741.  
  742.     # instantiation of printer driver handlers
  743.     if did['jockey_handler'] == 'PrinterDriverHandler' and not explicit_handler:
  744.         if 'free' not in did.properties or \
  745.            'description' not in did.properties or \
  746.            'package' not in did.properties:
  747.            logging.warning('DriverID for printer driver %s does not '
  748.                'specify free/description/package; ignoring', str(did))
  749.            return None
  750.  
  751.         hclass = handlers.PrinterDriverHandler
  752.         args.append('dummy') # name is overridden later
  753.         kwargs['description'] = ''
  754.  
  755.     # TODO: HandlerGroup standard handlers
  756.  
  757.     # default: look up handler in the handler pool
  758.     if not hclass:
  759.         try:
  760.             hclass = backend.handler_pool[did['jockey_handler']].__class__
  761.         except KeyError:
  762.             pass
  763.  
  764.     if not hclass:
  765.         return None
  766.  
  767.     # create instance and set specific properties from DriverID
  768.     try:
  769.         h = hclass(backend, *args, **kwargs)
  770.     except Exception, e:
  771.         logging.warning('could not instantiate handler class %s with args %s and kwargs %s: %s', 
  772.             str(hclass), str(args), str(kwargs), str(e))
  773.         return None
  774.  
  775.     if 'description' in did.properties:
  776.         h._name = _get_locale_string(did.properties['description'])
  777.     if 'long_description' in did.properties:
  778.         h._description = _get_locale_string(did.properties['long_description'])
  779.     if 'version' in did.properties:
  780.         h.version = did.properties['version']
  781.     if 'driver_vendor' in did.properties:
  782.         h.driver_vendor = did.properties['driver_vendor']
  783.     if 'package' in did.properties:
  784.         h.package = did.properties['package']
  785.     if 'repository' in did.properties:
  786.         h.repository = did.properties['repository']
  787.     if 'free' in did.properties:
  788.         h._free = did.properties['free']
  789.     if 'license' in did.properties:
  790.         h.license = did.properties['license']
  791.     if did.properties.get('recommended'):
  792.         h._recommended = True
  793.  
  794.     return _handler_license_filter(h, mode)
  795.  
  796. _driverid_to_handler.ignored = None
  797.  
  798. def _get_locale_string(map):
  799.     '''Given a locale ΓåÆ string map, return the one for the current locale.'''
  800.  
  801.     loc = locale.getlocale(locale.LC_MESSAGES)[0] or 'C'
  802.     lang = loc.split('_')[0]
  803.     if loc in map:
  804.         return map[loc]
  805.     elif lang in map:
  806.         return map[lang]
  807.     else:
  808.         return map['C']
  809.  
  810. #--------------------------------------------------------------------#
  811. # public functions
  812.  
  813. def get_modinfo(module):
  814.     '''Return information about a kernel module.
  815.     
  816.     This is delivered as a dictionary; keys are property names (strings),
  817.     values are lists of strings (some properties might have multiple
  818.     values, such as multi-line description fields or multiple PCI
  819.     modaliases).
  820.     '''
  821.     try:
  822.         return get_modinfo.cache[module]
  823.     except KeyError:
  824.         pass
  825.  
  826.     proc = subprocess.Popen((OSLib.inst.modinfo_path, module),
  827.         stdout=subprocess.PIPE, stderr=subprocess.PIPE)
  828.     (stdout, stderr) = proc.communicate()
  829.     if proc.returncode != 0:
  830.         logging.warning('modinfo for module %s failed: %s' % (module, stderr))
  831.         return None
  832.  
  833.     modinfo = {}
  834.     for line in stdout.split('\n'):
  835.         if ':' not in line:
  836.             continue
  837.  
  838.         (key, value) = line.split(':', 1)
  839.         modinfo.setdefault(key.strip(), []).append(value.strip())
  840.  
  841.     get_modinfo.cache[module] = modinfo
  842.     return modinfo
  843.  
  844. get_modinfo.cache = {}
  845.  
  846. def get_hardware():
  847.     '''Return a set of HardwareID objects for the local hardware.'''
  848.  
  849.     # modaliases
  850.     result = _get_modaliases()
  851.     # printer device IDs
  852.     result.update(_get_printers())
  853.  
  854.     # other hardware detection goes here
  855.  
  856.     return result
  857.  
  858. (MODE_FREE, MODE_NONFREE, MODE_ANY) = range(3)
  859.  
  860. def get_handlers(backend, driverdb=None, handler_dir=None, mode=MODE_ANY,
  861.     available_only=True, hardware=None, hardware_only=False):
  862.     '''Return a set of handlers which are applicable on this system.
  863.     
  864.     backend (a Backend instance) is passed to the generated handlers. If a
  865.     DriverDB instance is given (or a list of DriverDB objects), this will be
  866.     queried for unknown detected devices and possible handlers for them.
  867.     handler_dir specifies the directory where the custom handlers are stored
  868.     (can be a list, too); if None, it defaults to OSLib.handler_dir.
  869.     
  870.     If mode is set to MODE_FREE, this will deliver only free handlers;
  871.     MODE_NONFREE will only deliver nonfree handlers; by default (MODE_ANY), all
  872.     available handlers are returned, regardless of their license.
  873.  
  874.     Usually this function only returns drivers that match the available
  875.     hardware. With available_only=False, all handlers are returned (This is
  876.     only useful for testing, though)
  877.  
  878.     By default, get_hardware() is called for detecting the local hardware; if
  879.     that set is already known, it can be passed explicitly.
  880.  
  881.     If hardware_only is True, then this will only return handlers which match
  882.     one of the hardware IDs in the "hardware" argument; otherwise all available
  883.     drivers are returned.
  884.     '''
  885.     available_handlers = set()
  886.  
  887.     # get all custom handlers which are available
  888.     if handler_dir == None:
  889.         handler_dir = OSLib.inst.handler_dir
  890.     if hasattr(handler_dir, 'isspace'):
  891.         handler_dir = [handler_dir]
  892.     for dir in handler_dir:
  893.         for mod in glob(os.path.join(dir, '*.py')):
  894.             symb = {}
  895.             logging.debug('loading custom handler %s', mod)
  896.             try:
  897.                 execfile(mod, symb)
  898.             except Exception:
  899.                 logging.warning('Invalid custom handler module %s', mod,
  900.                     exc_info=True)
  901.                 continue
  902.  
  903.             for name, obj in symb.iteritems():
  904.                 try:
  905.                     # ignore non-Handler things; also ignore imports of
  906.                     # standard base handlers into the global namespace
  907.                     if not issubclass(obj, handlers.Handler) or \
  908.                         hasattr(handlers, name) or hasattr(xorg_driver, name):
  909.                         continue
  910.                 except TypeError:
  911.                     continue
  912.  
  913.                 try:
  914.                     inst = obj(backend)
  915.                     desc = inst.name()
  916.                 except:
  917.                     logging.debug('Could not instantiate Handler subclass %s from name %s',
  918.                         str(obj), name, exc_info=True)
  919.                     continue
  920.  
  921.                 logging.debug('Instantiated Handler subclass %s from name %s',
  922.                     str(obj), name)
  923.                 inst = _handler_license_filter(inst, mode)
  924.                 if not inst:
  925.                     logging.debug('%s does not match license mode %i', str(obj), mode)
  926.                     continue
  927.  
  928.                 avail = (not available_only) or inst.available()
  929.                 if avail:
  930.                     if hardware_only:
  931.                         logging.debug('hardware_only -> ignoring available handler %s', desc)
  932.                     else:
  933.                         logging.debug('%s is available', desc)
  934.                         available_handlers.add(inst)
  935.                     backend.handler_pool[name] = inst
  936.                 elif avail == None:
  937.                     logging.debug('%s availability undetermined, adding to pool', desc)
  938.                     backend.handler_pool[name] = inst
  939.                 else:
  940.                     logging.debug('%s not available', desc)
  941.  
  942.     logging.debug('all custom handlers loaded')
  943.  
  944.     if not driverdb:
  945.         return available_handlers
  946.  
  947.     # ask the driver dbs about all hardware
  948.     if isinstance(driverdb, DriverDB):
  949.         driverdb = [driverdb]
  950.     if hardware is None:
  951.         hardware = get_hardware()
  952.     for db in driverdb:
  953.         available_handlers.update(get_db_handlers(backend, db, hardware, mode))
  954.     return available_handlers
  955.  
  956. def get_db_handlers(backend, db, hardware, mode=MODE_ANY):
  957.     '''Return handlers for given hardware from a particular DriverDB.
  958.     
  959.     backend (a Backend instance) is passed to the generated handlers.
  960.  
  961.     If mode is set to MODE_FREE, this will deliver only free handlers;
  962.     MODE_NONFREE will only deliver nonfree handlers; by default (MODE_ANY), all
  963.     available handlers are returned, regardless of their license.
  964.     '''
  965.     available_handlers = set()
  966.     for hwid in hardware:
  967.         logging.debug('querying driver db %s about %s', db, hwid)
  968.         dids = db.query(hwid)
  969.  
  970.         # if the DB returns just one handler, do not show it as recommended
  971.         # even if the DB marks it as such; since there is no alternative, it
  972.         # would just be confusing
  973.         if len(dids) == 1:
  974.             try:
  975.                 del dids[0].properties['recommended']
  976.                 logging.debug('DriverID %s for %s is the only alternative, removed recommendation', str(dids[0].properties), hwid)
  977.             except KeyError:
  978.                 pass
  979.  
  980.         for did in dids:
  981.             h = _driverid_to_handler(did, backend, mode)
  982.             if h:
  983.                 if h.available() == False:
  984.                     logging.debug('ignoring unavailable handler %s', h)
  985.                     continue
  986.                 logging.debug('got handler %s', h)
  987.                 h._hwids.append(hwid)
  988.                 available_handlers.add(h)
  989.             else:
  990.                 logging.debug('no corresponding handler available for %s',
  991.                     did.properties)
  992.  
  993.     return available_handlers
  994.  
  995.  
  996.